HLS Salesforce Data Cloud System API - Implementation Template
Developer guide
This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.
Module | Description |
---|---|
condition-json-to-csv | Condition JSON to CSV mapping |
condition-json-to-json | Condition JSON to CDP Streaming JSON mapping |
immunization-json-to-csv | Immunization JSON to CSV mapping |
immunization-json-to-json | Immunization JSON to CDP Streaming JSON mapping |
webEngagement-json-to-csv | Web Engagement JSON to CSV mapping |
webEngagement-json-to-json | Web Engagement JSON to CDP Streaming JSON mapping |
job-details-response | Job Details Response Mapping |
condition-json-to-csv
Condition JSON to CSV mapping
Source:
./src/main/resources/dwl/condition-json-to-csv.dwl
Mapping Tables
Maps Condition JSON to CSV for CDP Bulk Upload
condition JSON Fields | CDP Ingestion API condition CSV Fields | Description | |||||
---|---|---|---|---|---|---|---|
patientId | patientId | The unique id assigned to the patient record in the EHR system | |||||
patientMrn | patientMrn | The Medical Record Number of the patient | |||||
conditionCode | conditionCode | Identification of the condition | |||||
description | conditionDescription | Additional information about the condition | |||||
clinicalStatus | clinicalStatus | Condition clinical status (active | recurrence | relapse | inactive | remission | resolved) |
severity | conditionSeverity | Subjective severity of the condition (Severe | Moderate | Mild) | |||
chronicFlag | chronicFlag | The flag determines whether the condition is chronic type | |||||
recordedDate | recordedDate | Date record was first recorded | |||||
resolvedDate | resolvedDate | Date when was condition resolved | |||||
sourceSystemId | sourceSystemId | The unique id assigned to condition record in EHR system | |||||
currDateTime | lastModifiedDate | Current Time stamp of this entry |
condition-json-to-json
Condition JSON to CDP Streaming JSON mapping
Source:
./src/main/resources/dwl/condition-json-to-json.dwl
Mapping Tables
Maps Condition JSON to JSON for CDP Streaming Upload
condition JSON Fields | CDP Ingestion API condition CSV Fields | Description | |||||
---|---|---|---|---|---|---|---|
patientId | patientId | The unique id assigned to the patient record in the EHR system | |||||
patientMrn | patientMrn | The Medical Record Number of the patient | |||||
conditionCode | conditionCode | Identification of the condition | |||||
description | conditionDescription | Additional information about the condition | |||||
clinicalStatus | clinicalStatus | Condition clinical status (active | recurrence | relapse | inactive | remission | resolved) |
severity | conditionSeverity | Subjective severity of the condition (Severe | Moderate | Mild) | |||
chronicFlag | chronicFlag | The flag determines whether the condition is chronic type | |||||
recordedDate | recordedDate | Date record was first recorded | |||||
resolvedDate | resolvedDate | Date when was condition resolved | |||||
sourceSystemId | sourceSystemId | The unique id assigned to condition record in EHR system | |||||
currDateTime | lastModifiedDate | Current Time stamp of this entry |
immunization-json-to-csv
Immunization JSON to CSV mapping
Source:
./src/main/resources/dwl/immunization-json-to-csv.dwl
Mapping Tables
Maps Immunization JSON to CSV for CDP Bulk Upload
immunization JSON Fields | CDP Ingestion API immunization CSV Fields | Description |
---|---|---|
patientId | patientId | The unique id assigned to the patient record in the EHR system |
patientMrn | patientMrn | The Medical Record Number of the patient |
vaccineCode | vaccineCode | Identifies the vaccine substance administered - CVX codes |
vaccineDescription | vaccineDescription | Name and additional details of the vaccine |
vaccineGroup | vaccineGroup | Category of the vaccine |
vaccineStatus | vaccineStatus | Immunization status code |
dose | dose | Amount of vaccine administered |
vaccineDate | vaccineDate | Vaccine administration date |
sourceSystemId | sourceSystemId | The unique id assigned to immunization record in EHR system |
currDateTime | lastModifiedDate | Current Time stamp of this entry |
immunization-json-to-json
Immunization JSON to CDP Streaming JSON mapping
Source:
./src/main/resources/dwl/immunization-json-to-json.dwl
Mapping Tables
Maps Immunization JSON to JSON for CDP Streaming Upload
immunization JSON Fields | CDP Ingestion API immunization CSV Fields | Description |
---|---|---|
patientId | patientId | The unique id assigned to the patient record in the EHR system |
patientMrn | patientMrn | The Medical Record Number of the patient |
vaccineCode | vaccineCode | Identifies the vaccine substance administered - CVX codes |
vaccineDescription | vaccineDescription | Name and additional details of the vaccine |
vaccineGroup | vaccineGroup | Category of the vaccine |
vaccineStatus | vaccineStatus | Immunization status code |
dose | dose | Amount of vaccine administered |
vaccineDate | vaccineDate | Vaccine administration date |
sourceSystemId | sourceSystemId | The unique id assigned to immunization record in EHR system |
currDateTime | lastModifiedDate | Current Time stamp of this entry |
webEngagement-json-to-csv
Web Engagement JSON to CSV mapping
Source:
./src/main/resources/dwl/webEngagement-json-to-csv.dwl
Mapping Tables
Maps Web Engagement JSON to CSV for CDP Bulk Upload
webEngagement JSON Fields | CDP Ingestion API webEngagement CSV Fields | Description |
---|---|---|
individualId | userId | Id of the patient user account |
emailAddress | emailAddress | The email Id of the patient user account |
sessionId | sessionId | The unique number assigned to the user's session for the duration of the visit |
memberName | memberName | The name of the patient |
contentName | contentName | The name of the content that the patient visited on the website |
contentType | contentType | The type of the content that the patient visited on the website |
pageViews | pageViews | The number of times the page is viewed |
averageTimeonPage | averageTimeonPage | The average duration of the time the user is on the page in seconds |
lastVisitedDate | lastVisitedDate | Date last visited by the user |
currDateTime | lastModifiedDate | Current Time stamp of this entry |
webEngagement-json-to-json
Web Engagement JSON to CDP Streaming JSON mapping
Source:
./src/main/resources/dwl/webEngagement-json-to-json.dwl
Mapping Tables
Maps Web Engagement JSON to JSON for CDP Bulk Upload
webEngagement JSON Fields | CDP Ingestion API webEngagement JSON Fields | Description |
---|---|---|
individualId | userId | Id of the patient user account |
emailAddress | emailAddress | The email Id of the patient user account |
sessionId | sessionId | The unique number assigned to the user's session for the duration of the visit |
memberName | memberName | The name of the patient |
contentName | contentName | The name of the content that the patient visited on the website |
contentType | contentType | The type of the content that the patient visited on the website |
pageViews | pageViews | The number of times the page is viewed |
averageTimeonPage | averageTimeonPage | The average duration of the time the user is on the page in seconds |
lastVisitedDate | lastVisitedDate | Date last visited by the user |
currDateTime | lastModifiedDate | Current Time stamp of this entry |
job-details-response
Job Details Response Mapping
Source:
./src/main/resources/dwl/job-details-response.dwl
Mapping Tables
Maps Job Details for Bulk Ingestion Jobs response
Target Fields | CDP Source Fields | Description |
---|---|---|
id | id | The unique id to identify the job |
operation | operation | The processing operation for the job |
sourceName | sourceName | The name of the connector that represents the source of the object |
state | state | The current state of the job |
createdDate | createdDate | The date and time when the job was created |
retries | retries | The number of retries |
processingTime | processingTime | The amount of time taken to process the job |